Skip to content

Eventqueue Templatewall Doxygen Rework #7810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Aug 24, 2018
Merged

Eventqueue Templatewall Doxygen Rework #7810

merged 5 commits into from
Aug 24, 2018

Conversation

kegilbert
Copy link
Contributor

@kegilbert kegilbert commented Aug 16, 2018 •
edited
Loading

Description

The doxygen for the EventQueue API (and Callback class but that's not covered in this PR) are illegible due to how the classes are implemented/doxygen-ified before. Chris and Vincent set up this solution a while back, just implementing the rest of their work: #7303

Additionally added some inline examples on how to setup/call the different overloaded methods in EventQueue. NOTE: Will squash the commit history following any feedback

Before

image

After

image

Example of expanded function doc

image

@geky Lot of copy and pasting, so may have borked one of the comment headers or examples in the new vararg function declarations.
@AnotherButler

Feel free to add anyone else to the review.

Pull request type

[ ] Fix
[X] Refactor
[ ] Target update
[ ] Functionality change
[ ] Breaking change

@kegilbert kegilbert requested review from geky and pan- August 16, 2018 22:31
pan-
pan- reviewed Aug 17, 2018
View reviewed changes
Copy link
Member

@pan- pan- left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That looks promising.

I think it would be valuable to document the template types requirements with the tag @tparam.

Any change we got the same update for the Event and Callback classes ?

@kegilbert
Copy link
Contributor Author

kegilbert commented Aug 17, 2018 •
edited
Loading

@pan- I was thinking about adding the tparam blocks, can definitely put them back in. After that update if this looks good I'd like to do the same to the Callback class.

geky
geky approved these changes Aug 17, 2018
View reviewed changes
Copy link
Contributor

@geky geky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! 👍

The documentation looks great and I like the added examples for each function.

@0xc0170 0xc0170 requested a review from AnotherButler August 20, 2018 16:30
Copy edit EventQueue.h
935db68 
Copy edit file for consistent capitalization, tense and voice.
@AnotherButler AnotherButler mentioned this pull request Aug 20, 2018
Closed
@0xc0170
Copy link
Contributor

0xc0170 commented Aug 22, 2018

/morph build

@mbed-ci
Copy link

mbed-ci commented Aug 22, 2018

Build : SUCCESS

Build number : 2865
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/7810/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

@0xc0170
Copy link
Contributor

0xc0170 commented Aug 22, 2018

/morph mbed2-build

@mbed-ci
Copy link

mbed-ci commented Aug 22, 2018

Exporter Build : FAILURE

Build number : 2495
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/7810/

@mbed-ci
Copy link

mbed-ci commented Aug 23, 2018

Test : SUCCESS

Build number : 2630
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/7810/2630

@cmonr
Copy link
Contributor

cmonr commented Aug 23, 2018

/morph export-build

@mbed-ci
Copy link

mbed-ci commented Aug 23, 2018

Exporter Build : FAILURE

Build number : 2507
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/7810/

@cmonr
Copy link
Contributor

cmonr commented Aug 23, 2018

Wow. An eclipse runtime error.
At least that's a new one.

/morph export-build

@mbed-ci
Copy link

mbed-ci commented Aug 23, 2018

Exporter Build : SUCCESS

Build number : 2508
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/7810/

@0xc0170 0xc0170 merged commit 05b2d6e into ARMmbed:master Aug 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pan- pan- pan- left review comments

@geky geky geky approved these changes

@AnotherButler AnotherButler AnotherButler approved these changes

Assignees
No one assigned
Labels
release-version: 5.9.7
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@kegilbert @0xc0170 @mbed-ci @cmonr @pan- @geky @AnotherButler